/*
 * Copyright 2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.internal.problems.failure;

import org.jspecify.annotations.Nullable;

/**
 * Classifies stack frames by their {@link StackTraceRelevance relevance}.
 * <p>
 * Classifiers are meant to be heuristic, determining the relevance on the best-effort basis.
 */
public interface StackTraceClassifier {

    StackTraceClassifier USER_CODE = new StackTraceClassifier() {
        @Override
        public StackTraceRelevance classify(StackTraceElement frame) {
            return StackTraceRelevance.USER_CODE;
        }
    };

    /**
     * Returns relevance for the given frame, or null if the classifier does not have an opinion.
     */
    @Nullable
    StackTraceRelevance classify(StackTraceElement frame);

}
